A partner can be a client or a vendor, currently we only use them for clients.
| name | value |
|---|---|
| partnerNumber | P-31010 |
| personType | LEGAL_PERSON |
| tradeName | Test AG |
| contactCaption | Test AG - Hamburg |
| postalAddress | “firm”: “Test AG”, “department”: “Geschäftsleitung”, “street”: “Shanghai-Allee 1”, “zipcode”: “20123”, “city”: “Hamburg”, “country”: “Germany” |
| officePhoneNumber | +49 40 654321-0 |
| emailAddress | hamburg@test-ag.example.org |
| registrationOffice | Registergericht Hamburg |
| registrationNumber | 1234567 |
HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
-H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
`# {` \
`# "sub" : "uuid<hsh-alex_superuser>"` \
`# }`
=> status: 200 OK
[ {
"uuid" : "882bda1d-4e5e-42f8-afdd-b9741d1c1f4e", // Person: Hostsharing eG
"personType" : "LEGAL_PERSON",
"tradeName" : "Hostsharing eG",
"salutation" : null,
"title" : null,
"givenName" : null,
"familyName" : null
} ]
Even in production data we expect this query to return just a single result.
HTTP POST "/api/hs/office/persons" \
-H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
`# {` \
`# "sub" : "uuid<hsh-alex_superuser>"` \
`# }` \
<<EOF
{
"personType" : "LEGAL_PERSON",
"tradeName" : "Test AG"
}
EOF
=> status: 201 CREATED 9e12338f-c1ea-4237-9d64-f085a84850c6
HTTP POST "/api/hs/office/contacts" \
-H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
`# {` \
`# "sub" : "uuid<hsh-alex_superuser>"` \
`# }` \
<<EOF
{
"caption" : "Test AG - Hamburg",
"postalAddress" : {
"firm" : "Test AG",
"department" : "Geschäftsleitung",
"street" : "Shanghai-Allee 1",
"zipcode" : "20123",
"city" : "Hamburg",
"country" : "Germany"
},
"phoneNumbers" : {
"office" : "+49 40 654321-0"
},
"emailAddresses" : {
"main" : "hamburg@test-ag.example.org"
}
}
EOF
=> status: 201 CREATED 9876b091-c67a-4316-b880-ccb925b826cb
HTTP POST "/api/hs/office/partners" \
-H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
`# {` \
`# "sub" : "uuid<hsh-alex_superuser>"` \
`# }` \
<<EOF
{
"partnerNumber" : "P-31010",
"partnerRel" : {
"anchor.uuid" : "882bda1d-4e5e-42f8-afdd-b9741d1c1f4e", // Person: Hostsharing eG
"holder.uuid" : "9e12338f-c1ea-4237-9d64-f085a84850c6", // Person: Test AG
"contact.uuid" : "9876b091-c67a-4316-b880-ccb925b826cb" // Contact: Test AG - Hamburg
},
"details" : {
"registrationOffice" : "Registergericht Hamburg",
"registrationNumber" : "1234567"
}
}
EOF
=> status: 201 CREATED 17f118e3-af4e-44b2-a512-6a2a331570a4
HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Test+AG+-+Hamburg" \
-H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
`# {` \
`# "sub" : "uuid<hsh-alex_superuser>"` \
`# }`
=> status: 200 OK
[ {
"uuid" : "22b0c1b5-5b3b-4cd1-8c56-464f71deeac3",
"anchor" : {
"uuid" : "882bda1d-4e5e-42f8-afdd-b9741d1c1f4e", // Person: Hostsharing eG
"personType" : "LEGAL_PERSON",
"tradeName" : "Hostsharing eG",
"salutation" : null,
"title" : null,
"givenName" : null,
"familyName" : null
},
"holder" : {
"uuid" : "9e12338f-c1ea-4237-9d64-f085a84850c6", // Person: Test AG
"personType" : "LEGAL_PERSON",
"tradeName" : "Test AG",
"salutation" : null,
"title" : null,
"givenName" : null,
"familyName" : null
},
"type" : "PARTNER",
"mark" : null,
"contact" : {
"uuid" : "9876b091-c67a-4316-b880-ccb925b826cb", // Contact: Test AG - Hamburg
"caption" : "Test AG - Hamburg",
"postalAddress" : {
"zipcode" : "20123",
"firm" : "Test AG",
"country" : "Germany",
"city" : "Hamburg",
"street" : "Shanghai-Allee 1",
"department" : "Geschäftsleitung"
},
"emailAddresses" : {
"main" : "hamburg@test-ag.example.org"
},
"phoneNumbers" : {
"office" : "+49 40 654321-0"
}
}
} ]
generated on 2026-08-10 04:34:19 for branch HEAD